<?php

/**
 * Interface declaration for Structures_Location_XX_Resource classes
 * (where XX is a 2-letter country code)
 *
 * PHP version 5
 *
 * LICENSE:
 *
 * Copyright (c) 2008-2009, Philippe Jausions / 11abacus
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   - Redistributions of source code must retain the above copyright notice,
 *     this list of conditions and the following disclaimer.
 *   - Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *   - Neither the name of 11abacus nor the names of its contributors may
 *     be used to endorse or promote products derived from this software
 *     without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * @category  Structures
 * @package   Structures_Location
 * @author    Philippe Jausions <Philippe.Jausions@11abacus.com>
 * @copyright 2007-2009 by Philippe Jausions / 11abacus
 * @license   http://www.opensource.net/licenses/bsd-license.php New BSD
 */

/**
 * Interface declaration for Structures_Location_XX_Resource classes
 * (where XX is a 2-letter country code)
 *
 * @category Structures
 * @package  Structures_Location
 * @author   Philippe Jausions <Philippe.Jausions@11abacus.com>
 */
interface Structures_Location_PostalResourceInterface
{
    /**
     * Returns list of region codes and names
     *
     * @param string $type Region type to narrow the list to
     * 
     * @return array Region code => name
     * @see    getRegionTypes()
     */
    public function getPostalRegions($type = null);

    /**
     * Returns list of sub-region codes and names
     * 
     * @param string $regionCode NULL or region code
     * @param string $type       Sub-region type to narrow the list to
     *
     * @return array Sub-region code => name
     * @see    getSubRegionTypes()
     */
    public function getPostalSubRegions($region = null, $type = null);

    /**
     * Returns a list of region types available
     * 
     * The types returned can be used with getRegions() method
     *
     * @return array Region type => name
     * @see    getRegions()
     */
    public function getPostalRegionTypes();

    /**
     * Returns a list of sub-region types available
     * 
     * The types returned can be used with getSubRegions() method
     *
     * @return array Sub-region type => name
     * @see    getSubRegions()
     */
    public function getPostalSubRegionTypes();

    /**
     * Returns a list of country codes for which a country's official 
     * postal service directly delivers mails for.
     *
     * @return array List of 2 upper case letter country codes (ISO-3166-2)
     */
    public function getPostalDeliveryCountryCodes();

    /**
     * Returns the list of countries that is in charge of delivering the mail
     *
     * @return array 2 upper case letter country codes (ISO-3166-2)
     */
    public function getPostalDelivererCountryCodes();
}

?>